/*
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at 
 * 
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *  
 */

using System;
using System.Text;
using java = biz.ritter.javapi;

namespace org.apache.commons.collections.keyvalue
{

    /**
     * Abstract pair class to assist with creating <code>KeyValue</code>
     * and {@link java.util.Map.Entry Map.Entry} implementations.
     *
     * @since Commons Collections 3.0
     * @version $Revision$ $Date$
     * 
     * @author James Strachan
     * @author Michael A. Smith
     * @author Neil O'Toole
     * @author Stephen Colebourne
     */
    public abstract class AbstractKeyValue : KeyValue {

        /** The key */
        protected Object key;
        /** The value */
        protected Object value;

        /**
         * Constructs a new pair with the specified key and given value.
         *
         * @param key  the key for the entry, may be null
         * @param value  the value for the entry, may be null
         */
        protected AbstractKeyValue(Object key, Object value) :base(){
            this.key = key;
            this.value = value;
        }

        /**
         * Gets the key from the pair.
         *
         * @return the key 
         */
        public virtual Object getKey() {
            return key;
        }

        /**
         * Gets the value from the pair.
         *
         * @return the value
         */
        public virtual Object getValue() {
            return value;
        }

        /**
         * Gets a debugging String view of the pair.
         * 
         * @return a String view of the entry
         */
        public override String ToString() {
            return new StringBuilder()
                .append(getKey())
                .append('=')
                .append(getValue())
                .toString();
        }

    }
}